Skip to main content
PUT
/
v1
/
shipping
/
retailers
/
{id}
/
ship-to-locations
/
{location_id}
Update Retailer Ship-To Location
curl --request PUT \
  --url https://{base_url_domain}/api/global/v1/shipping/retailers/{id}/ship-to-locations/{location_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "DC-001",
  "qualifier_x12": "92",
  "label": "Bentonville DC",
  "location_type": "dc",
  "company": "Walmart DC",
  "street": "<string>",
  "city": "Bentonville",
  "region_id": 6,
  "region": "AR",
  "postcode": "72712",
  "country_id": "US",
  "telephone": "+1-479-273-4000",
  "email": "dc6045@example.com",
  "is_default": true,
  "status": "active"
}
'
{
  "errors": [
    {
      "type": "parameters",
      "message": "The supplied parameters are invalid.",
      "details": [
        {
          "key": "hold_until_date",
          "message": "The date must be in the future."
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
id
integer<int32>
required

The id of the parent Retailer.

Required range: x >= 1
​
location_id
integer<int32>
required

The id of the referenced RetailerShipToLocation.

Required range: x >= 1

Body

application/json

An object conforming to the RetailerShipToLocation schema to be merged.

A RetailerShipToLocation represents an EDI N1*ST destination (distribution center, store, mark-for, drop-ship, or other) under a Retailer.

​
code
string
required

Unique location code within the parent Retailer + merchant.

Required string length: 1 - 64
Example:

"DC-001"

​
qualifier_x12
string | null

Optional X12 location qualifier.
Optional Field

Maximum string length: 4
Example:

"92"

​
label
string | null

Optional display label.

Maximum string length: 255
Example:

"Bentonville DC"

​
location_type
enum<string>
default:dc

Location type.

Available options:
dc,
store,
mark_for,
drop_ship,
other
Example:

"dc"

​
company
string | null

Optional company name.
Optional Field

Maximum string length: 255
Example:

"Walmart DC"

​
street
string | null

Optional street address; may contain newlines.
Optional Field

​
city
string | null

Optional city.
Optional Field

Maximum string length: 255
Example:

"Bentonville"

​
region_id
integer<int32> | null

Optional Magento directory_country_region id. Reserved for future integration.
Optional Field

Example:

6

​
region
string | null

Optional free-form region (state/province).
Optional Field

Maximum string length: 255
Example:

"AR"

​
postcode
string | null

Optional postal code.
Optional Field

Maximum string length: 32
Example:

"72712"

​
country_id
string | null

Optional two-letter ISO country code. Normalized to uppercase by the server.
Optional Field

Maximum string length: 2
Example:

"US"

​
telephone
string | null

Optional telephone number.
Optional Field

Maximum string length: 32
Example:

"+1-479-273-4000"

​
email
string<email> | null

Optional email address.
Optional Field

Maximum string length: 255
Example:

"dc6045@example.com"

​
is_default
boolean
default:false

When true on save, sibling default locations under the same Retailer are atomically unset.

Example:

true

​
status
enum<string>
default:active

Location lifecycle status.

Available options:
active,
inactive
Example:

"active"

​
retailer
RetailerRef · object

Parent Retailer reference. Set from the path; cannot be changed.

Response

OK - The operation completed successfully and there is no response body.